route-service API

route-service supports 13 commands:

Services: pos eve edp status route sensor msg cfg asset mod map sys tftp eng tag rec aprec test index

/epe/route/getpath POST version		Input:	Output:
	Description: Used to find path between two points using model topology. Role Required: viewer Call Counter: Total: 0, Failed: 0	tagid (optional) - [long] source tag id mac (optional) - [String] source tag MAC address targettagid (optional) - [long] target tag id targetmac (optional) - [String] target tag mac mapid (optional) - [long] source location mapId x (optional) - [int] source location x-coordinate y (optional) - [int] source location y-coordinate	PATH.mapid - [Array] Array path point mapIds PATH.x - [Array] Array path point x coordinates PATH.y - [Array] Array path point y coordinates
/epe/route/navigate POST version		Input:	Output:
	Description: Provides user an answer to a question: Where should I go to find at least one tag from the specified group in a shortest possible time. User defines a source tag where the route starts and the target tag group where the route should end. Target tag can be specified individually or by specifing a tag group or set of tags by id or mac address.Command can also be controlled be defining a set of zones that should be avoided or where the user knows that the target object does not exist. Result of the command is a list of directions that should be followed in order to find the target. Role Required: viewer Call Counter: Total: 0, Failed: 0	tagid (optional) - [long] source tag id mac (optional) - [String] source tag MAC address targettagid (optional) - [Array] Array target tag ids targetmac (optional) - [Array] Array target tag mac targettaggroupid (optional) - [Array] target tags as taggroup avoidzoneid (optional) - [Array] Array avoided zone ids visitedzoneid (optional) - [Array] Array visited zone ids	PATHSTEP.mapid - [Array] Array path point mapIds PATHSTEP.x - [Array] Array path point x coordinates PATHSTEP.y - [Array] Array path point y coordinates PATHSTEP.pathLenghtM - [Array] path lenght in meters PATHSTEP.targetzoneid - [long] Id of the zone where user should go to find a target PATHSTEP.targetzonename - [String] Name of the zone where user should go to find a target PATHSTEP.targetzoneprob - [float] probability that zone contains at least one target
/epe/route/routecontrol POST version		Input:	Output:
	Description: Enables user to activate/deactivate route generation Role Required: poweruser Call Counter: Total: 0, Failed: 0	enabled (optional) - [String] Controls route generation state. set true/false depending on requested action
/epe/route/routehistorybrowse POST version		Input:	Output:
	Description: Browse route history. Role Required: viewer Call Counter: Total: 0, Failed: 0	tagid (optional) - [Array] list entries related to specific devices, specified by device ids mac (optional) - [Array] list entries related to specific devices, specified by MAC addresses assetid (optional) - [Array] list entries related to specific assets, specified by asset ids since (optional) - [String] list entries since the specified time. there are two alternative formats; the point of time can be given as milliseconds elapsed since midnight UTC of January 1, 1970. another option is to use the ISO 8601 notation (yyyy-MM-dd hh:mm:ssZ). time zone is optional; if it's omitted, the input is interpreted as server's local time until (optional) - [String] list entries until the specified time. format is the same as with since within (optional) - [String] list entries occured within the given time period, format 1s for one second, 2m for two minutes, 3h for three hours, 4d for four days time (optional) - [long] status change entry timestamp numlatest (optional) - [int] max number of entries to list, newest first numoldest (optional) - [int] max number of entries to list, oldest first sort (optional) - [String] sorts output into given order. Allowed values are 'ascending' and 'descending'. Can not be used simultaneously with 'numlatest' or 'numoldest' streaming (optional) - [String] if set to true, returns history as a stream format (optional) - [String] format of output, compact or xml; default is xml show (optional) - [String] one of the following: ZONE=return only route points where zone changes, ALL=return all route points; default ALL	ROUTEPOINT.tagid - [long] id of a device ROUTEPOINT.assetid - [long] asset identifier ROUTEPOINT.mac - [String] MAC address of a device ROUTEPOINT.timestamp - [long] entry time stamp in milliseconds since January 1, 1970, 00:00:00 GMT ROUTEPOINT.modelid - [long] id of the model where the tag route point is ROUTEPOINT.zoneid - [int] id of the zone where the tag route point is ROUTEPOINT.mapid - [int] id of the map where the tag route point is ROUTEPOINT.x - [int] X coordinate ROUTEPOINT.y - [int] Y coordinate ROUTEPOINT.timetoscan - [long] Time delta to nearest scan in milliseconds ROUTEPOINT.jump - [String] Route point jump status. If true, the route between the previous route point and this route point is unknown.
/epe/route/routehistoryinfo		Input:	Output:
	Description: Provides basic information about route history in an efficient way. The provided counters are informative and may be slightly inexact, use routehistorylist if higher accuracy is needed. Role Required: viewer Call Counter: Total: 3, Failed: 0		ROUTEDATA.count - [long] Number of route points in history ROUTEDATA.firsttimestamp - [String] First entry time stamp in milliseconds since January 1, 1970, 00:00:00 GMT ROUTEDATA.lasttimestamp - [String] last entry time stamp in milliseconds since January 1, 1970, 00:00:00 GMT
/epe/route/routehistorylist POST version		Input:	Output:
	Description: Provides information about route history. Role Required: viewer Call Counter: Total: 0, Failed: 0	tagid (optional) - [Array] list entries related to specific devices, specified by device ids mac (optional) - [Array] list entries related to specific devices, specified by MAC addresses assetid (optional) - [Array] list entries related to specific assets, specified by asset ids since (optional) - [String] list entries since the specified time. there are two alternative formats; the point of time can be given as milliseconds elapsed since midnight UTC of January 1, 1970. another option is to use the ISO 8601 notation (yyyy-MM-dd hh:mm:ssZ). time zone is optional; if it's omitted, the input is interpreted as server's local time until (optional) - [String] list entries until the specified time. format is the same as with since within (optional) - [String] list entries occured within the given time period, format 1s for one second, 2m for two minutes, 3h for three hours, 4d for four days time (optional) - [long] route point entry timestamp	ROUTEDATA.tagid - [long] id of a device ROUTEDATA.assetid - [long] id of an asset ROUTEDATA.count - [long] Number of route points within the specified constraints ROUTEDATA.firsttimestamp - [String] First entry time stamp in milliseconds since January 1, 1970, 00:00:00 GMT ROUTEDATA.lasttimestamp - [String] last entry time stamp in milliseconds since January 1, 1970, 00:00:00 GMT
/epe/route/routehistorysnapshot POST version		Input:	Output:
	Description: Gets snapshot in time of route history. Role Required: viewer Call Counter: Total: 0, Failed: 0	time (optional) - [long] snapshot time, leave empty for current time tagid (optional) - [Array] list entries related to specific devices, specified by device ids; ALL for all tags mac (optional) - [Array] list entries related to specific devices, specified by MAC addresses assetid (optional) - [Array] list entries related to specific assets, specified by asset ids; ALL for all assets	ROUTEPOINT.tagid - [long] id of a device ROUTEPOINT.assetid - [long] asset identifier ROUTEPOINT.mac - [String] MAC address of a device ROUTEPOINT.timestamp - [String] entry time stamp in milliseconds since January 1, 1970, 00:00:00 GMT ROUTEPOINT.modelid - [String] id of the model where the tag route point is ROUTEPOINT.zoneid - [String] id of the zone where the tag route point is ROUTEPOINT.mapid - [String] id of the map where the tag route point is ROUTEPOINT.x - [String] X coordinate ROUTEPOINT.y - [String] Y coordinate ROUTEPOINT.timetoscan - [String] Time delta to nearest scan in milliseconds ROUTEPOINT.jump - [String] Route point jump status. If true, the route between the previous route point and this route point is unknown.
/epe/route/routestream POST version		Input:	Output:
	Description: Receive route points from the RTLS Controller after they are generated. The connection stays active forever. Server queues up events and may drop any new route points if the client does not read the stream fast enough. Technically this call uses HTTP 1.1 chunked transfer, which provides a way to send multiple chunks of data without closing the connection. See the HTTP specification for the format of the chunks. (The Java SDK automatically takes care of chunking.) A QUERYALIVE message is sent in 10 second interval to check connection aliveness. Ignore this message. Example 1: Receive route points for tag 3003121667 /epe/route/routestream?tagid=3003121667 Example 2: Receive route points for tag with mac 00:00:B3:00:00:05 /epe/route/routestream?mac=00:00:B3:00:00:05 Example 3: Receive route points for tags in group 1 /epe/route/routestream?taggroupid=1 Example 4: Receive route points for asset 47 /epe/route/routestream?assetid=47 Role Required: viewer Call Counter: Total: 0, Failed: 0	mac (optional) - [Array] macs of the tags tagid (optional) - [Array] ids of the tags taggroupid (optional) - [Array] ids of the tag groups assetid (optional) - [Array] ids of the assets	ROUTEPOINT.assetid - [long] asset identifier ROUTEPOINT.mac - [String] MAC address ROUTEPOINT.type - [String] device type (such as t201 or t301) ROUTEPOINT.name - [String] device name ROUTEPOINT.modelid - [String] id of the model where the tag route point is ROUTEPOINT.mapid - [int] id of the map where the tag is ROUTEPOINT.zoneid - [String] id of the zone where the tag route point is ROUTEPOINT.x - [int] X coordinate ROUTEPOINT.y - [int] Y coordinate ROUTEPOINT.timestamp - [String] route point time stamp in milliseconds since January 1, 1970, 00:00:00 GMT ROUTEPOINT.timetoscan - [String] Time delta to nearest scan in milliseconds ROUTEPOINT.jump - [String] Route point jump status. If true, the route between the previous route point and this route point is unknown.
/epe/route/routetagcontrol POST version		Input:	Output:
	Description: Enables user to set route generation state manually for tag and view current settings. Role Required: poweruser Call Counter: Total: 0, Failed: 0	tagid (optional) - [String] Id of the tag, or array of ids mac (optional) - [String] Mac address of the tag, or array or addresses state (optional) - [String] When 'state' parameter is given, the command sets state for given specified tags. When 'state' is not given, the command shows the current state. Possible states are 'forced-on', 'forced-off', 'auto'	TAG.mac - [String] MAC address TAG.config - [String] Config state for tag. Possible states are 'forced-on', 'forced-off', 'auto' TAG.state - [String] Actual config state for tag. Actual state changes when route points are generated for the specific tag.
/epe/route/sortbydistance POST version		Input:	Output:
	Description: Returns list of tags sorted based on their distance from the selected source position. Distance is calculated using the topology defined in the positioning model. Source position is selected either by selecting a source tag or by selecting coordinates. When coordinates are used, the source location is mapped to the closest rail or openspace defined in the model. Search space can and should be limited by defining additional search criteria including 'maxdistance', 'maxresults' and 'adjacentfloors'. Role Required: viewer Call Counter: Total: 0, Failed: 0	tagid (optional) - [long] source tag id mac (optional) - [String] source tag MAC address targettagid (optional) - [Array] Array target tag ids targetmac (optional) - [Array] Array target tag mac targettaggroupid (optional) - [Array] target tags as taggroup mapid (optional) - [long] source location mapId x (optional) - [int] source location x-coordinate y (optional) - [int] source location y-coordinate maxdistance (optional) - [float] Maximum searched distance. Search distance is not limited by default. maxresults (optional) - [int] Maximum number of results included in search. Returns 5 results by default. adjacentfloors (optional) - [int] Number of adjacent floors included in search. Possible values: 0 - search current floor only (default), 1 - Search one floor below and above.	FOUND.mapid - [long] mapId of the found target location FOUND.x - [int] x coordinate of the target location FOUND.y - [int] y coordinate of the target location FOUND.pathLenghtM - [float] path lenght in meters FOUND.zoneid - [long] Id of the zone where user should go to find a target FOUND.zonename - [String] Name of the zone where user should go to find a target FOUND.tagid - [long] Id of the found tag FOUND.mac - [long] Mac address of the found tag FOUND.assetid - [long] Asset id of the found tag FOUND.lastseen - [String] Time when target was last seen
/epe/route/_clear		Input:	Output:
	Description: SPECIAL. Resets all service specific counters. Role Required: poweruser Call Counter: Total: 0, Failed: 0
/epe/route/_list POST version		Input:	Output:
	Description: SPECIAL. Lists the available commands, their arguments, responses, required roles, call counters and optional help descriptions. Role Required: Call Counter: Total: 1, Failed: 0	help (optional) - [int] set to 1 to get also HTML help description of the commands. Default is 0.	COMMAND.name - [String] command name COMMAND.arg - [String] mandatory argument COMMAND.optarg - [String] optional argument COMMAND.response - [String] response field COMMAND.internal - [int] 1 for internal command COMMAND.role - [String] required role COMMAND.callcount - [int] number of calls COMMAND.callcountinternal - [int] number of internal calls COMMAND.callcountfailure - [int] number of failed calls COMMAND.htmlhelp - [String] command description in HTML format
/epe/route/_status		Input:	Output:
	Description: SPECIAL. Returns status information about the service. Role Required: viewer Call Counter: Total: 0, Failed: 0		STATUS.callcount - [int] total number of calls for the service STATUS.callcountinternal - [int] total number of internal calls for the service STATUS.callcountfailure - [int] total number of failed calls for the service STATUS.commandcount - [int] number of commands in service STATUS.* - [String] service specific status information

(The data in this page was generated from /epe/route/_list?help=1)